Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

English anchors more beautifications #1675

Merged
merged 25 commits into from Mar 30, 2022

Conversation

smoe
Copy link
Contributor

@smoe smoe commented Mar 22, 2022

Stuff that I thought could have some wait in my local repository until I came across getting-started/pncconf_fr.adoc and its images that should be in config/ together with its counterparts from other lingos.

@smoe
Copy link
Contributor Author

smoe commented Mar 22, 2022

This was rebased on #1670, was a few patches only.

@smoe smoe force-pushed the EnglishAnchorsMoreBeautifications branch from f2d91ed to b6dceed Compare March 22, 2022 14:59
@smoe
Copy link
Contributor Author

smoe commented Mar 23, 2022

The _fr documentation got a bit confused over all the files I moved between directories and somehow the anchors in stepconf_fr.adoc did not make into the check. My answer now is to cut any exception that _fr is doing to the builds so what builds for _en should also work for _fr. Well, I am writing this while the build is still running.

@smoe smoe force-pushed the EnglishAnchorsMoreBeautifications branch from 370638e to c5aa6ce Compare March 23, 2022 15:45
@smoe
Copy link
Contributor Author

smoe commented Mar 23, 2022

@petterreinholdtsen This builds for me - no idea why the autobuilds are not showing up. Have freshly rebased against master. Please have a look. I'd consider it worthwhile to rebase to this branch again. The most noticable change for you likely is that the Master_*.adoc files now also adhere to the "_"-as-a-sep-for-language-suffix-principle.
@silopolis , I have removed the Master_HAL.adoc that triggered problems with files moved between directories for me but created Master-Documentation_fr and Master-Development_fr as a substitute. This means that we have three languages now in sync.

@silopolis
Copy link
Contributor

I think I remember having made such changes in my PR to translate-po4a... Anyway, whatever leads us forward!

@smoe
Copy link
Contributor Author

smoe commented Mar 24, 2022

@silopolis I admittedly guessed that you may have done something like that but was a bit desperate with the error message that did not want to disappear :) We should to get our efforts merged. The questions is - how.

I could merge what you have but would prefer if you go through master. How would you like the following approach:

  • you rebase your po4a branch to the current master
  • you prepare a diff against master into something like po4a_fr_20220324.patch
  • you remove the po4a scripts of @petterreinholdtsen from that patch
  • from master, not the po4a branch, you branch of with a new "changes_to_prepare_FR_for_po4a"-branch
  • you apply that patch and commit
  • you get it to build, commit and push for a PR
  • I merge your effort with mine with this branch

And then it may be time to recap what remains to be done.

Best,
Steffen

@smoe
Copy link
Contributor Author

smoe commented Mar 24, 2022

This builds for me.

@smoe
Copy link
Contributor Author

smoe commented Mar 25, 2022

@hansu , @petterreinholdtsen , @silopolis , it builds. No idea why it now builds, but it builds. It took so long since I had removed some more all-English files that only existed because of the anchors. I also removed quite a few anchors that are not referenced anywhere. I only hope that these simplifications are indeed as helpful to get po4a going as I expect them to be. My reasoning was that anything that is not existing we also do not need to keep in sync for the po4a generation.

Something unexpected I did was, after a discussion with @petterreinholdtsen about using the underscore only to separate the language tag, to rename the docs/src/Master_Documentation etc documents to have a hyphen, i.e. it is Master-Documentation etc now. The only exception to this rule that I am aware of is in the man pages since there are binaries with an underscore.

@silopolis, please have a look at what I have done. I hope that you, and @petterreinholdtsen, like this enough to consider this as a target to merge your _fr/po4a changes with. Secondo me, we can then have our first iterations of .po file generations.

@petterreinholdtsen , I had given it some thoughts and liked the idea to have separate .po files for each subfolder of the documentation. How do you think about this? My motivation is to have some (presumed more important) fragments of the documentation translated earlier than others, and (more importantly) to have translators assign themselves to those areas where they feel to have some expertise. EDIT: Another reason to have separate .po files is to grant us a bit of extra time to get everything in sync for the initial .po file generation.

Cheers,
Steffen

@petterreinholdtsen
Copy link
Collaborator

petterreinholdtsen commented Mar 25, 2022 via email

@smoe
Copy link
Contributor Author

smoe commented Mar 25, 2022

@petterreinholdtsen - It should definitely go in before your's since the only purpose of this effort is to help your po4a cause by removing differences between languages and by removing parts that are not translated :)

I am tempted to suggest to update the po4a package of ours, then :)

@silopolis
Copy link
Contributor

silopolis commented Mar 25, 2022 via email

@smoe
Copy link
Contributor Author

smoe commented Mar 25, 2022

Motivation to split are:

  • match with translator's expertise
  • have an earlier feeling of success when something approaches the 95% translation
  • we do not have all the pressure upfront to sync all the files between es/fr and en, but then again, it is not that bad.

@silopolis
Copy link
Contributor

silopolis commented Mar 25, 2022 via email

@smoe
Copy link
Contributor Author

smoe commented Mar 25, 2022

@SebKuzminsky , I mentioned it above, I have changed the LinuxCNC_* etc files to LinuxCNC-Development/LinuxCNC-Documentatation/LinuxCNC-Getting-Started/LinuxCNC-Manual-Pages. Is that ok with you? @petterreinholdtsen, you do not really care, right for po4a, or do you? The movitaton was to have the language suffices separated by an underscore and not use the underscore elsewhere, but I should not have embedded this in this PR. Shall I undo this?

@silopolis
Copy link
Contributor

silopolis commented Mar 25, 2022 via email

@smoe
Copy link
Contributor Author

smoe commented Mar 25, 2022

How's that better than branching from master and cherrypicking from my
po4a branch ?

I presume it is pretty much the same thing, just manual.

@smoe smoe force-pushed the EnglishAnchorsMoreBeautifications branch from edbfa95 to aa5502d Compare March 29, 2022 14:32
@smoe
Copy link
Contributor Author

smoe commented Mar 29, 2022

@hansu , this is what @silopolis ' po4a "match the _en and _fr files"-branch should rebase on. In principle this would be something for the docs-devel-branch, except that @petterreinholdtsen 's branch removes the _es and _fr files, so we cannot continue the update of the .po files in said docs-devel-branch.

I am not 100%ish sure about how to then continue. Someone needs to redo the _es and _fr .po file generation. @petterreinholdtsen , is that you or me? Also, someone needs to prepare the _es and _fr files for this. @silopolis, is that you? I suggest that I stop working on the po4a bits until I hear from either of you to work through some next step with me. That way I do not confuse anyone.

@hansu , if you do not mind too much, please accept this PR for master again. My work then stops here.

@petterreinholdtsen
Copy link
Collaborator

petterreinholdtsen commented Mar 29, 2022 via email

@hansu hansu added the po4a label Mar 30, 2022
@smoe smoe force-pushed the EnglishAnchorsMoreBeautifications branch from aa5502d to 2c61e0b Compare March 30, 2022 16:18
@@ -1,134 +0,0 @@
:lang: es
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is still deleted... please restore

@smoe smoe force-pushed the EnglishAnchorsMoreBeautifications branch from 2c61e0b to 9fd029e Compare March 30, 2022 16:36
@smoe
Copy link
Contributor Author

smoe commented Mar 30, 2022

Touchy_es was surprisingly close to the original. Good it is back. Thanks again.

@hansu
Copy link
Member

hansu commented Mar 30, 2022

Now ready for merge?

@smoe
Copy link
Contributor Author

smoe commented Mar 30, 2022

Once it builds, yes, please. I just hope there wasn't another reference to something non-existing.

@hansu hansu merged commit 103122a into LinuxCNC:master Mar 30, 2022
@hansu
Copy link
Member

hansu commented Mar 30, 2022

Nice, Thank you!

@smoe
Copy link
Contributor Author

smoe commented Mar 30, 2022

@hansu - great, many thanks for your review!
@silopolis - now it's about getting your changes to *_fr.adoc in and in particular all the reverse-translations to _en merged.

@smoe smoe deleted the EnglishAnchorsMoreBeautifications branch March 30, 2022 18:27
@petterreinholdtsen
Copy link
Collaborator

petterreinholdtsen commented Oct 11, 2022 via email

@petterreinholdtsen
Copy link
Collaborator

petterreinholdtsen commented Oct 11, 2022 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants